---
id: Banking - Credit Card-spec
title: "Ficha técnica"
handle: Recebíveis de Cartão de Crédito
description: ""
custom_edit_url: null
---
## Escopos necessários

O token para consumir a API de Recebíveis de cartão de crédito deve ser gerado usando o [Authorization Code](https://developers.empresas.btgpactual.com/docs/authorization-code).

O escopo `openid` é obrigatório. Ele permite consultar o perfil do usuário BTG com acesso à conta.

É necessário informar um dos seguintes escopos na realização do fluxo:

| Escopo                                              | Descrição                                                              |
| :-------------------------------------------------- | :--------------------------------------------------------------------- |
| `brn:btg:empresas:receivables:credit-card`          | Permite a consulta dos dados e criação de uma antecipação de recebível |
| `brn:btg:empresas:receivables:credit-card.readonly` | Permite consulta do dados de uma antecipação de recebível              |
| `brn:btg:empresas:scf:sub-acquirers`                | Permite utilização das APIs de subcredenciadora e bancos emissores     |

## Máquina de estados do Recebível

![](../../static/Produtos%20de%20API/Banking/Recebíveis%20de%20Cartão%20de%20Crédito/maquina-de-estados.png)

## Códigos de Erro

A tabela abaixo contém os códigos de erros que a API devolve, quando falha em operar, e suas respectivas descrições indicando o causador da falha.

| Código   | Descrição                                                    |
| -------- | ------------------------------------------------------------ |
| OPRCC000 | Erro inesperado                                              |
| OPRCC001 | Empresa não cadastrada                                       |
| OPRCC002 | Conta de Desembolso não cadastrada                           |
| OPRCC003 | Nenhum recebível solicitado foi encontrado                   |
| OPRCC004 | Recebíveis solicitados não pertencem a empresa               |
| OPRCC005 | Recebíveis solicitados não estão disponíveis para antecipar  |
| OPRCC006 | Valor solicitado maior que o valor disponível para antecipar |
| OPRCC007 | Valor solicitado menor que o valor mínimo possível           |
| OPRCC008 | Limite não cadastrado para a empresa                         |
| OPRCC009 | Operação fora da grade horária                               |
| OPRCC010 | Empresa não pode operar por não pagar o Saldo Devedor        |
| OPRCC011 | Paginador com valores inconsistentes                         |

## Eventos de webhook

Os payloads disponíveis abaixo representam o conteúdo do campo `data`, seguindo o formato do envio descrito em [Eventos](https://developers.empresas.btgpactual.com/v1.5/docs/utilize-webhooks-para-receber-atualiza%C3%A7%C3%B5es-sobre-produtos-conectados#/eventos).

| Evento                                                         | Descrição                                              |
| :------------------------------------------------------------- | :----------------------------------------------------- |
| `receivables-credit-card.balance-summary`                      | Informe do saldo devedor                               |
| `receivables-credit-card.batch-receivable-update`              | Atualização dos recebíveis em lote                     |
| `receivables-credit-card.batch-operation-update`               | Atualização das operações em lote                      |
| `receivables-credit-card.sub-acquirer.batch-receivable-update` | Atualização dos recebíveis de subcredencidoras em lote |

### receivables-credit-card.balance-summary

Enviado todos os dias às 10h.

```json
{
    "companyId": "37297902000141",
    "dueTodayReceivablesUnpaidAmount": "0.00",
    "overdueReceivablesUnpaidAmount": "0.00",
    "receivablesOverdue": [
    {
        "status": "InDisbursement",
        "balance": "114.72",
        "interestArrears": "0.50",
        "latePaymentFee": "0",
        "penaltyFee": "2.30",
        "maturityDate": "2025-01-29"
    }
  ]
}
```

### receivables-credit-card.batch-receivable-update

```json
[
    {
        "receivable": {
            "receivableId": 107629006,
            "payerId": "01027058000191",
            "payeeId": "37297902000141",
            "maturityDate": "2025-07-17",
            "scheme": "Elo",
            "maturityAmount": "4913.42",
            "status": "WaitingSignatures"
        },
        "registeredAmount": "0.00",
        "disbursementAmount": "4900.15"
    },
    {
        "receivable": {
            "receivableId": 107629612,
            "payerId": "01027058000191",
            "payeeId": "37297902000141",
            "maturityDate": "2025-07-18",
            "scheme": "AmericanExpress",
            "maturityAmount": "1065.60",
            "status": "WaitingSignatures"
        },
        "registeredAmount": "0.00",
        "disbursementAmount": "1061.76"
    }
]
```

### receivables-credit-card.batch-operation-update

```json
[
    {
        "operation": {
            "operationId": 59428,
            "status": "Cancelled",
            "payerId": "01027058000191",
            "payeeId": "37297902000141"
        }
    }
]
```